Module Contents
alltypes
Module Contents
interface ABoundSocket
interface AConnectedSocket : AWritable
interface AReadable
interface ASocket : Closeable, DisposableHandle
interface AWritable
open class AbstractHashedMap<K : Any, V : Any> : AbstractMap<K, V>
abstract class AbstractLinkedMap<K : Any, V : Any> : AbstractHashedMap<K, V>
open class AcceptAllCookiesStorage : CookiesStorage
interface Acceptable<out S : ASocket> : ASocket
class ActorSelectorManager : SelectorManagerSupport, Closeable
data class AndRouteSelector : RouteSelector
object Apache : HttpClientEngineFactory<ApacheEngineConfig>
typealias ApacheBackend = Apache
class ApacheEngineConfig : HttpClientEngineConfig
class Application : ApplicationCallPipeline
interface ApplicationCall
open class ApplicationCallPipeline : Pipeline<Unit, ApplicationCall>
interface ApplicationConfig
interface ApplicationConfigValue
class ApplicationConfigurationException : Exception
interface ApplicationEngine
interface ApplicationEngineEnvironment : ApplicationEnvironment
class ApplicationEngineEnvironmentBuilder
class ApplicationEngineEnvironmentReloading : ApplicationEngineEnvironment
interface ApplicationEngineFactory<out TEngine : ApplicationEngine, TConfiguration : Configuration>
interface ApplicationEnvironment
class ApplicationEvents
interface ApplicationFeature<in TPipeline : Pipeline<*, ApplicationCall>, out TConfiguration : Any, TFeature : Any>
open class ApplicationReceivePipeline : Pipeline<ApplicationReceiveRequest, ApplicationCall>
class ApplicationReceiveRequest
interface ApplicationRequest
interface ApplicationResponse
open class ApplicationSendPipeline : Pipeline<Any, ApplicationCall>
open class AsyncServletApplicationCall : BaseApplicationCall
class AsyncServletApplicationRequest : ServletApplicationRequest
open class AsyncServletApplicationResponse : ServletApplicationResponse
class AttributeKey<T>
class Attributes
object AuthScheme
class Authentication
class AuthenticationContext
sealed class AuthenticationFailedCause
class AuthenticationPipeline : Pipeline<AuthenticationContext, ApplicationCall>
class AuthenticationProcedureChallenge
open class AuthenticationProvider
class AuthenticationRouteSelector : RouteSelector
object AutoHeadResponse : ApplicationFeature<ApplicationCallPipeline, Unit, Unit>
class BadContentTypeFormatException : Exception
abstract class BaseApplicationCall : ApplicationCall
abstract class BaseApplicationEngine : ApplicationEngine
abstract class BaseApplicationRequest : ApplicationRequest
abstract class BaseApplicationResponse : ApplicationResponse
class BasicAuth
class BasicAuthenticationProvider : AuthenticationProvider
class BlockingServletApplicationCall : BaseApplicationCall
interface BoundDatagramSocket : ASocket, ABoundSocket, AReadable, DatagramReadWriteChannel
open class BuildersTest : TestWithKtor
class ByteArrayContent : ByteArrayContent
class ByteBufferBuilder
object CIO : HttpClientEngineFactory<CIOEngineConfig>
object CIO : ApplicationEngineFactory<CIOApplicationEngine, Configuration>
class CIOApplicationCall : BaseApplicationCall
class CIOApplicationEngine : BaseApplicationEngine
class CIOApplicationRequest : BaseApplicationRequest
class CIOApplicationResponse : BaseApplicationResponse
class CIOEngineConfig : HttpClientEngineConfig
class CIOHeaders : Headers
class CIOIncomingContent : IncomingContent
class CIOMultipartData : CIOMultipartDataBase
open class CIOMultipartDataBase : MultiPartData
class CORS
interface Cache<in K : Any, V : Any>
object CacheControl
sealed class CacheControl
class CacheStorage : SessionStorage
abstract class CacheTest : TestWithKtor
class CachingHeaders
data class CachingOptions
class CallLogging
class CaseInsensitiveMap<V> : AbstractLinkedMap<String, V>, MutableMap<String, V>
open class ChannelIOException : IOException
class ChannelReadException : ChannelIOException
class ChannelWriteException : ChannelIOException
class CipherSuite
Module Contents
CipherSuite(code: Short, name: String, openSSLName: String, exchangeType: SecretExchangeType, jdkCipherName: String, keyStrength: Int, fixedIvLength: Int, ivLength: Int, cipherTagSizeInBytes: Int, macName: String, macStrength: Int, hashName: String)
val cipherTagSizeInBytes: Int
val code: Short
val exchangeType: SecretExchangeType
val fixedIvLength: Int
val hashName: String
val ivLength: Int
val jdkCipherName: String
val keyStrength: Int
val keyStrengthInBytes: Int
val macName: String
val macStrength: Int
val macStrengthInBytes: Int
val name: String
val openSSLName: String
class ClientClosedException : IllegalStateException
abstract class ClientUpgradeContent : NoContent
interface ClientWebSocketSession : WebSocketSession
typealias CloseReason = CloseReason
data class CloseReason
class Compression
interface CompressionEncoder
class CompressionEncoderBuilder : ConditionsHolderBuilder
data class CompressionEncoderConfig
data class CompressionOptions
class ConditionalHeaders
interface ConditionsHolderBuilder
interface Configurable<out T : Configurable<T>>
class ConnectException : Exception
interface ConnectedDatagramSocket : ASocket, ABoundSocket, AConnectedSocket, ReadWriteSocket, DatagramReadWriteChannel
class ConnectionOptions
data class ConnectorType
class ConstantCookieStorage : CookiesStorage
data class ConstantParameterRouteSelector : RouteSelector
interface ContentConverter
class ContentDisposition : HeaderValueWithParameters
class ContentNegotiation
sealed class ContentRange
open class ContentTest : TestWithKtor
class ContentTransformationException : Exception
class ContentType : HeaderValueWithParameters
@DslMarker @Target([AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.TYPE, AnnotationTarget.FUNCTION]) annotation class ContextDsl
interface ConversionService
data class Cookie
Module Contents
Cookie(name: String, value: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING, maxAge: Int = 0, expires: Temporal? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap())
val domain: String?
val encoding: CookieEncoding
val expires: Temporal?
val extensions: Map<String, String?>
val httpOnly: Boolean
val maxAge: Int
val name: String
val path: String?
val secure: Boolean
val value: String
class CookieConfiguration
enum class CookieEncoding
class CookieIdSessionBuilder<S : Any> : CookieSessionBuilder<S>
open class CookieSessionBuilder<S : Any>
interface CookiesStorage
abstract class CookiesTest : TestWithKtor
interface Credential
interface CurrentSession
class DataConversion : ConversionService
class DataConversionException : Exception
class Datagram
interface DatagramReadChannel
interface DatagramReadWriteChannel : DatagramReadChannel, DatagramWriteChannel
interface DatagramWriteChannel
typealias DecoderJob = WriterJob
class DefaultClientWebSocketSession : ClientWebSocketSession, DefaultWebSocketSession
object DefaultConversionService : ConversionService
class DefaultHeaders
object DefaultOAuth2StateProvider : OAuth2StateProvider
class DefaultResponsePushBuilder : ResponsePushBuilder
object DefaultServletUpgrade : ServletUpgrade
interface DefaultWebSocketServerSession : DefaultWebSocketSession, WebSocketServerSession
interface DefaultWebSocketSession : WebSocketSession
class DefaultWebSocketSessionImpl : DefaultWebSocketSession, WebSocketSession
object DeflateEncoder : CompressionEncoder
class DelegatingConversionService : ConversionService
object DevelopmentEngine
object DevelopmentEngine
object DevelopmentEngine
object DevelopmentEngine
class DigestAuthenticationProvider : AuthenticationProvider
data class DigestCredential : Credential
class DispatcherWithShutdown : CoroutineDispatcher
class DoubleReceiveException : IllegalStateException
class DuplicateApplicationFeatureException : Exception
object EmptyContent : NoContent
object EmptyHeaders : Headers
object EmptyParameters : Parameters
typealias EncoderJob = ReaderJob
class EndpointConfig
open class EngineConnectorBuilder : EngineConnectorConfig
interface EngineConnectorConfig
class EnginePipeline : Pipeline<Unit, ApplicationCall>
class EngineSSLConnectorBuilder : EngineConnectorBuilder, EngineSSLConnectorConfig
interface EngineSSLConnectorConfig : EngineConnectorConfig
abstract class EngineStressSuite<TEngine : ApplicationEngine, TConfiguration : Configuration> : EngineTestBase<TEngine, TConfiguration>
abstract class EngineTestBase<TEngine : ApplicationEngine, TConfiguration : Configuration>
abstract class EngineTestSuite<TEngine : ApplicationEngine, TConfiguration : Configuration> : EngineTestBase<TEngine, TConfiguration>
data class EntityTagVersion : Version
class EventDefinition<T>
typealias EventHandler<T> = (T) -> Unit
sealed class FormAuthChallenge
class FormAuthenticationProvider : AuthenticationProvider
object ForwardedHeaderSupport : ApplicationFeature<ApplicationCallPipeline, Unit, Unit>
typealias Frame = Frame
sealed class Frame
class FrameParser
typealias FrameType = FrameType
enum class FrameType
class FreeMarker
class FreeMarkerContent
abstract class FullFormTest : TestWithKtor
class GsonConverter : ContentConverter
class GsonSerializer : JsonSerializer
class GsonSupport
object GzipEncoder : CompressionEncoder
class HSTS
class HeaderIdSessionBuilder<S : Any> : HeaderSessionBuilder<S>
open class HeaderSessionBuilder<S : Any>
data class HeaderValue
enum class HeaderValueEncoding
data class HeaderValueParam
abstract class HeaderValueWithParameters
interface Headers : StringValues
class HeadersBuilder : StringValuesBuilder
class HeadersImpl : Headers, StringValuesImpl
class HeadersSingleImpl : Headers, StringValuesSingleImpl
open class HoconApplicationConfig : ApplicationConfig
class HtmlContent : WriteChannelContent
data class HttpAcceptRouteSelector : RouteSelector
sealed class HttpAuthHeader
class HttpClient : Closeable
class HttpClientCall : Closeable
class HttpClientConfig
object HttpClientDefaultPool : DefaultPool<ByteBuffer>
interface HttpClientEngine : Closeable
open class HttpClientEngineConfig
interface HttpClientEngineFactory<out T : HttpClientEngineConfig>
interface HttpClientFeature<out TBuilder : Any, TFeature : Any>
class HttpCookies
data class HttpEngineCall
data class HttpHeaderRouteSelector : RouteSelector
object HttpHeaders
class HttpHeadersMap
class HttpIgnoreBody
abstract class HttpMessage
interface HttpMessage
interface HttpMessageBuilder
data class HttpMethod
data class HttpMethodRouteSelector : RouteSelector
class HttpPlainText
data class HttpProtocolVersion
class HttpReceivePipeline : Pipeline<HttpResponse, HttpClientCall>
class HttpRedirect
open class HttpRedirectTest : TestWithKtor
interface HttpRequest : HttpMessage
class HttpRequestBuilder : HttpMessageBuilder
class HttpRequestData
typealias HttpRequestHandler = suspend (request: Request, input: ByteReadChannel, output: ByteWriteChannel, upgraded: CompletableDeferred<Boolean>?) -> Unit
class HttpRequestPipeline : Pipeline<Any, HttpRequestBuilder>
interface HttpResponse : HttpMessage, Closeable
data class HttpResponseContainer
class HttpResponsePipeline : Pipeline<HttpResponseContainer, HttpClientCall>
class HttpSendPipeline : Pipeline<Any, HttpRequestBuilder>
class HttpServer
data class HttpServerSettings
data class HttpStatusCode
class HttpStatusCodeContent : NoContent
class HttpsConfig
class HttpsRedirect
class IOCoroutineDispatcher : CoroutineDispatcher, Closeable
object IdentityEncoder : CompressionEncoder
interface IncomingContent : HttpMessage
class InterestSuspensionsMap
class InvalidPhaseException : Throwable
object It
class JWTAuthenticationProvider : AuthenticationProvider
class JWTCredential : Credential
class JWTPrincipal : Principal
class JacksonConverter : ContentConverter
class JarFileContent : ReadChannelContent
object Jetty : HttpClientEngineFactory<JettyEngineConfig>
object Jetty : ApplicationEngineFactory<JettyApplicationEngine, Configuration>
class JettyApplicationCall : AsyncServletApplicationCall
class JettyApplicationEngine : JettyApplicationEngineBase
open class JettyApplicationEngineBase : BaseApplicationEngine
class JettyApplicationResponse : AsyncServletApplicationResponse
class JettyEngineConfig : HttpClientEngineConfig
object JettyUpgradeImpl : ServletUpgrade
class JsonFeature
interface JsonSerializer
object KtorDefaultPool : DefaultPool<ByteBuffer>
abstract class KtorServlet : HttpServlet
data class LastModifiedVersion : Version
class LinkHeader : HeaderValueWithParameters
class LocalFileContent : ReadChannelContent
annotation class Location
class LocationAttributeRouteService : LocationRouteService
interface LocationRouteService
open class Locations
class MapApplicationConfig : ApplicationConfig
class Metrics
class MissingApplicationFeatureException : IllegalStateException
interface MultiPartData
sealed class MultipartEvent
abstract class MultithreadedTest : TestWithKtor
class MutableOriginConnectionPoint : RequestConnectionPoint
object Netty : ApplicationEngineFactory<NettyApplicationEngine, Configuration>
abstract class NettyApplicationCall : BaseApplicationCall
class NettyApplicationEngine : BaseApplicationEngine
abstract class NettyApplicationRequest : BaseApplicationRequest
class NettyApplicationRequestHeaders : Headers
abstract class NettyApplicationResponse : BaseApplicationResponse
class NettyCallPool : NioEventLoopGroup
class NettyConnectionPool : NioEventLoopGroup
class NettyHttpIncomingContent : IncomingContent
class NettyWorkerPool : NioEventLoopGroup
class NoTransformationFound : UnsupportedOperationException
object NoopContinuation : Continuation<Any?>
object OAuth2RequestParameters
object OAuth2ResponseParameters
interface OAuth2StateProvider
sealed class OAuthAccessTokenResponse : Principal
class OAuthAuthenticationProvider : AuthenticationProvider
sealed class OAuthCallback
object OAuthGrantTypes
sealed class OAuthServerSettings
enum class OAuthVersion
object On
data class OptionalParameterRouteSelector : RouteSelector
data class OrRouteSelector : RouteSelector
sealed class OutgoingContent
data class ParameterRouteSelector : RouteSelector
interface Parameters : StringValues
class ParametersBuilder : StringValuesBuilder
class ParametersImpl : Parameters, StringValuesImpl
class ParametersSingleImpl : Parameters, StringValuesSingleImpl
class ParserException : Exception
sealed class PartData
class PartialContent
typealias PartialContentSupport = PartialContent
data class PathSegmentConstantRouteSelector : RouteSelector
data class PathSegmentOptionalParameterRouteSelector : RouteSelector
data class PathSegmentParameterRouteSelector : RouteSelector
object PathSegmentSelectorBuilder
data class PathSegmentTailcardRouteSelector : RouteSelector
object PathSegmentWildcardRouteSelector : RouteSelector
open class Pipeline<TSubject : Any, TContext : Any>
class PipelineContext<TSubject : Any, out TContext : Any>
typealias PipelineInterceptor<TSubject, TContext> = suspend PipelineContext<TSubject, TContext>.(TSubject) -> Unit
class PipelinePhase
open class Placeholder<TOuter>
class PlaceholderItem<TOuter> : Placeholder<TOuter>
open class PlaceholderList<TOuter, TInner>
abstract class PostTest : TestWithKtor
interface Principal
enum class RangeUnits
data class RangesSpecifier
class RawWebSocket : WebSocketSession
interface ReadWriteSocket : ASocket, AReadable, AWritable
class RedirectException : IllegalStateException
class Request : HttpMessage
interface RequestConnectionPoint
open class RequestCookies
class RequestResponseBuilder
class Response : HttpMessage
class ResponseCookies
Module Contents
ResponseCookies(response: ApplicationResponse, secureTransport: Boolean)
fun append(item: Cookie): Unit
fun append(name: String, value: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING, maxAge: Int = 0, expires: Temporal? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap()): Unit
fun appendExpired(name: String, domain: String? = null, path: String? = null): Unit
operator fun get(name: String): Cookie?
abstract class ResponseHeaders
interface ResponsePushBuilder
open class Route : ApplicationCallPipeline
abstract class RouteSelector
data class RouteSelectorEvaluation
class Routing : Route
class RoutingApplicationCall : ApplicationCall
class RoutingApplicationRequest : ApplicationRequest
class RoutingApplicationResponse : ApplicationResponse
class RoutingException : Exception
class RoutingPath
data class RoutingPathSegment
enum class RoutingPathSegmentKind
class RoutingResolveContext
sealed class RoutingResolveResult
class RoutingResolveTrace
open class RoutingResolveTraceEntry
enum class SecretExchangeType
enum class SelectInterest
interface Selectable : Closeable, DisposableHandle
interface SelectorManager
abstract class SelectorManagerSupport : SelectorManager
class Semaphore
class SemaphoreTest
class Serializer
interface ServerSocket : ASocket, ABoundSocket, Acceptable<Socket>
open class ServletApplicationEngine : KtorServlet
abstract class ServletApplicationRequest : BaseApplicationRequest
class ServletApplicationRequestCookies : RequestCookies
class ServletApplicationRequestHeaders : Headers
abstract class ServletApplicationResponse : BaseApplicationResponse
abstract class ServletIncomingContent : IncomingContent
interface ServletUpgrade
class ServletUpgradeHandler : HttpUpgradeHandler
sealed class SessionAuthChallenge<in T : Any>
class SessionAuthenticationProvider<T : Any> : AuthenticationProvider
class SessionProvider
interface SessionSerializer
class SessionSerializerReflection<T : Any> : SessionSerializer
interface SessionStorage
class SessionStorageMemory : SessionStorage
interface SessionTracker
class SessionTrackerById : SessionTracker
class SessionTrackerByValue : SessionTracker
interface SessionTransport
class SessionTransportCookie : SessionTransport
class SessionTransportHeader : SessionTransport
interface SessionTransportTransformer
class SessionTransportTransformerDigest : SessionTransportTransformer
class SessionTransportTransformerEncrypt : SessionTransportTransformer
class SessionTransportTransformerMessageAuthentication : SessionTransportTransformer
class Sessions
class ShutDownUrl
class SimpleFrameCollector
interface Socket : ReadWriteSocket, ABoundSocket, AConnectedSocket
class SocketBuilder : Configurable<SocketBuilder>
class SocketOptions
class StatusPages
class StressSuiteRunner : Runner
interface StringValues
open class StringValuesBuilder
open class StringValuesImpl : StringValues
open class StringValuesSingleImpl : StringValues
enum class TLSAlertLevel
enum class TLSAlertType
class TLSException : IOException
class TLSHandshakeHeader
enum class TLSHandshakeType
class TLSRecordHeader
enum class TLSRecordType
enum class TLSVersion
class TcpSocketBuilder : Configurable<TcpSocketBuilder>
interface Template<in TOuter>
open class TemplatePlaceholder<TTemplate>
class TestApplicationCall : BaseApplicationCall
class TestApplicationEngine : BaseApplicationEngine
class TestApplicationRequest : BaseApplicationRequest
class TestApplicationResponse : BaseApplicationResponse
class TestClientBuilder
object TestEngine : ApplicationEngineFactory<TestApplicationEngine, Configuration>
class TestHttpClientConfig : HttpClientEngineConfig
class TestHttpClientEngine : HttpClientEngine
class TestHttpClientRequest : HttpRequest
class TestHttpClientResponse : HttpResponse
abstract class TestWithKtor
class TextContent : ByteArrayContent
object Tomcat : ApplicationEngineFactory<TomcatApplicationEngine, Configuration>
class TomcatApplicationEngine : BaseApplicationEngine
class UDPSocketBuilder : Configurable<UDPSocketBuilder>
class URIFileContent : ReadChannelContent
class URLBuilder
data class URLProtocol
class UnauthorizedResponse : NoContent
class UnsafeHeaderException : IllegalArgumentException
class UnsupportedContentTypeException : IllegalStateException
class UnsupportedMediaTypeException : Exception
class UpgradeRequest
data class Url
class UserHashedTableAuth
data class UserIdPrincipal : Principal
data class UserPasswordCredential : Credential
interface ValuesMap
class Velocity
class VelocityContent
interface Version
enum class VersionCheckResult
class WeakTimeoutQueue
class WebSocketContent : ClientUpgradeContent
class WebSocketReader
interface WebSocketServerSession : WebSocketSession
interface WebSocketSession
class WebSocketUpgrade : ProtocolUpgrade
class WebSocketWriter
class WebSockets : AutoCloseable
class WebSockets
class WriterContent : WriteChannelContent
sealed class WriterEncapsulation
object XForwardedHeadersSupport : ApplicationFeature<ApplicationCallPipeline, Config, Config>
com.typesafe.config.Config
io.netty.util.concurrent.Future
java.io.File
java.io.File
java.io.InputStream
Module Contents
fun InputStream.toByteReadChannel(pool: ObjectPool<ByteBuffer> = KtorDefaultPool, parent: Job = Job()): ByteReadChannel
java.lang.Class
java.nio.ByteBuffer
java.nio.file.Path
java.nio.file.Path
java.time.temporal.Temporal
java.util.Date
Module Contents
fun Date.toLocalDateTime(): LocalDateTime
fun Date.toZonedDateTime(): ZonedDateTime
kotlin.Long
kotlin.String
kotlin.String
kotlin.collections.Iterable
kotlin.collections.List
kotlin.collections.List
kotlin.coroutines.experimental.CoroutineContext
kotlin.ranges.LongRange
kotlinx.coroutines.experimental.io.ByteReadChannel
kotlinx.coroutines.experimental.io.ByteReadChannel
kotlinx.coroutines.experimental.io.ByteReadChannel
kotlinx.coroutines.experimental.io.ByteWriteChannel
kotlinx.coroutines.experimental.io.ByteWriteChannel
kotlinx.io.core.BytePacketBuilder
kotlinx.io.core.ByteReadPacket
kotlinx.io.pool.ObjectPool
typealias location = Location
org.slf4j.Logger
package io.ktor.application
Module Contents
class Application : ApplicationCallPipeline
interface ApplicationCall
open class ApplicationCallPipeline : Pipeline<Unit, ApplicationCall>
interface ApplicationEnvironment
class ApplicationEvents
interface ApplicationFeature<in TPipeline : Pipeline<*, ApplicationCall>, out TConfiguration : Any, TFeature : Any>
val ApplicationStarted: EventDefinition<Application>
val ApplicationStarting: EventDefinition<Application>
val ApplicationStopPreparing: EventDefinition<ApplicationEnvironment>
val ApplicationStopped: EventDefinition<Application>
val ApplicationStopping: EventDefinition<Application>
class DuplicateApplicationFeatureException : Exception
class EventDefinition<T>
typealias EventHandler<T> = (T) -> Unit
class MissingApplicationFeatureException : IllegalStateException
val PipelineContext<*, ApplicationCall>.application: Application
inline val PipelineContext<*, ApplicationCall>.call: ApplicationCall
fun <A : Pipeline<*, ApplicationCall>, B : Any, F : Any> A.feature(feature: ApplicationFeature<A, B, F>): F
fun <A : Pipeline<*, ApplicationCall>, B : Any, F : Any> A.featureOrNull(feature: ApplicationFeature<A, B, F>): F?
fun <P : Pipeline<*, ApplicationCall>, B : Any, F : Any> P.install(feature: ApplicationFeature<P, B, F>, configure: B.() -> Unit = {}): F
val Application.log: Logger
fun <A : Pipeline<*, ApplicationCall>, B : Any, F : Any> A.uninstall(feature: ApplicationFeature<A, B, F>): Unit
fun <A : Pipeline<*, ApplicationCall>> A.uninstallAllFeatures(): Unit
fun <A : Pipeline<*, ApplicationCall>, F : Any> A.uninstallFeature(key: AttributeKey<F>): Unit
package io.ktor.auth
Module Contents
object AuthScheme
class Authentication
class AuthenticationContext
sealed class AuthenticationFailedCause
class AuthenticationPipeline : Pipeline<AuthenticationContext, ApplicationCall>
class AuthenticationProcedureChallenge
open class AuthenticationProvider
class AuthenticationRouteSelector : RouteSelector
class BasicAuthenticationProvider : AuthenticationProvider
interface Credential
object DefaultOAuth2StateProvider : OAuth2StateProvider
class DigestAuthenticationProvider : AuthenticationProvider
data class DigestCredential : Credential
sealed class FormAuthChallenge
class FormAuthenticationProvider : AuthenticationProvider
enum class HeaderValueEncoding
sealed class HttpAuthHeader
object OAuth2RequestParameters
object OAuth2ResponseParameters
interface OAuth2StateProvider
sealed class OAuthAccessTokenResponse : Principal
class OAuthAuthenticationProvider : AuthenticationProvider
sealed class OAuthCallback
object OAuthGrantTypes
val OAuthKey: Any
sealed class OAuthServerSettings
enum class OAuthVersion
interface Principal
sealed class SessionAuthChallenge<in T : Any>
const val SessionAuthChallengeKey: String
class SessionAuthenticationProvider<T : Any> : AuthenticationProvider
class UnauthorizedResponse : NoContent
class UserHashedTableAuth
data class UserIdPrincipal : Principal
data class UserPasswordCredential : Credential
fun Route.authenticate(vararg configurations: String? = arrayOf<String?>(null), build: Route.() -> Unit): Route
val ApplicationCall.authentication: AuthenticationContext
fun Application.authentication(body: Configuration.() -> Unit): Authentication
fun Configuration.basic(name: String? = null, configure: BasicAuthenticationProvider.() -> Unit): Unit
fun Configuration.basicAuthentication(realm: String, validate: suspend (UserPasswordCredential) -> Principal?): Unit
fun ApplicationRequest.basicAuthenticationCredentials(): UserPasswordCredential?
fun Configuration.digest(name: String? = null, configure: DigestAuthenticationProvider.() -> Unit): Unit
fun Configuration.digestAuthentication(realm: String = "ktor", digestAlgorithm: String = "MD5", digesterProvider: (String) -> MessageDigest = { MessageDigest.getInstance(it) }, userNameRealmPasswordDigestProvider: suspend (String, String) -> ByteArray?): Unit
fun ApplicationCall.digestAuthenticationCredentials(): DigestCredential?
fun DigestCredential.expectedDigest(method: HttpMethod, digester: MessageDigest, userNameRealmPasswordDigest: ByteArray): ByteArray
fun Configuration.form(name: String? = null, configure: FormAuthenticationProvider.() -> Unit): Unit
fun Configuration.formAuthentication(userParamName: String = "user", passwordParamName: String = "password", challenge: FormAuthChallenge = FormAuthChallenge.Unauthorized, validate: suspend (UserPasswordCredential) -> Principal?): Unit
fun Configuration.oauth(client: HttpClient, dispatcher: CoroutineDispatcher, providerLookup: ApplicationCall.() -> OAuthServerSettings?, urlProvider: ApplicationCall.(OAuthServerSettings) -> String): Unit
suspend fun PipelineContext<Unit, ApplicationCall>.oauth(client: HttpClient, dispatcher: CoroutineDispatcher, providerLookup: ApplicationCall.() -> OAuthServerSettings?, urlProvider: ApplicationCall.(OAuthServerSettings) -> String): Unit
fun Configuration.oauth(name: String? = null, configure: OAuthAuthenticationProvider.() -> Unit): Unit
suspend fun PipelineContext<Unit, ApplicationCall>.oauthHandleCallback(client: HttpClient, dispatcher: CoroutineDispatcher, provider: OAuthServerSettings, callbackUrl: String, loginPageUrl: String, configure: HttpRequestBuilder.() -> Unit = {}, block: suspend (OAuthAccessTokenResponse) -> Unit): Unit
suspend fun PipelineContext<Unit, ApplicationCall>.oauthRespondRedirect(client: HttpClient, dispatcher: CoroutineDispatcher, provider: OAuthServerSettings, callbackUrl: String): Unit
fun obtainRequestTokenHeader(: String, : String, : String, : LocalDateTime = LocalDateTime.now()): Parameterized
fun ApplicationRequest.parseAuthorizationHeader(): HttpAuthHeader?
fun parseAuthorizationHeader(: String): HttpAuthHeader?
inline fun <reified P : Principal> ApplicationCall.principal(): P?
inline fun <reified T : Principal> Configuration.session(name: String? = null, challenge: SessionAuthChallenge<T> = SessionAuthChallenge.Default): Unit
inline fun <reified T : Any> Configuration.session(name: String? = null, configure: Configuration<T>.() -> Unit): Unit
fun Parameterized.sign(: HttpMethod, : String, : String, : List<Pair<String, String>>): Parameterized
fun signatureBaseString(: Parameterized, : HttpMethod, : String, : List<HeaderValueParam>): String
fun Parameterized.toDigestCredential(): DigestCredential
fun upgradeRequestTokenHeader(: String, : String, : String, : LocalDateTime = LocalDateTime.now()): Parameterized
suspend fun DigestCredential.verifier(method: HttpMethod, digester: MessageDigest, userNameRealmPasswordDigest: suspend (String, String) -> ByteArray?): Boolean
suspend fun verifyWithOAuth2(c: UserPasswordCredential, client: HttpClient, settings: OAuth2ServerSettings): OAuth2
package io.ktor.auth.jwt
package io.ktor.auth.ldap
Module Contents
fun <K : Credential, P : Any> ldapAuthenticate(credential: K, ldapServerURL: String, ldapEnvironmentBuilder: (MutableMap<String, Any?>) -> Unit = {}, doVerify: InitialDirContext.(K) -> P?): P?
fun ldapAuthenticate(credential: UserPasswordCredential, ldapServerURL: String, userDNFormat: String, validate: InitialDirContext.(UserPasswordCredential) -> UserIdPrincipal?): UserIdPrincipal?
fun ldapAuthenticate(credential: UserPasswordCredential, ldapServerURL: String, userDNFormat: String): UserIdPrincipal?
package io.ktor.cio
package io.ktor.client
package io.ktor.client.call
package io.ktor.client.cio
package io.ktor.client.engine
package io.ktor.client.engine.apache
package io.ktor.client.engine.cio
package io.ktor.client.engine.jetty
package io.ktor.client.features
package io.ktor.client.features.auth.basic
package io.ktor.client.features.cookies
package io.ktor.client.features.json
package io.ktor.client.features.websocket
Module Contents
interface ClientWebSocketSession : WebSocketSession
class DefaultClientWebSocketSession : ClientWebSocketSession, DefaultWebSocketSession
class WebSocketContent : ClientUpgradeContent
class WebSockets : AutoCloseable
suspend fun HttpClient.webSocket(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = 80, path: String = "/", request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.webSocketRaw(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = 80, path: String = "/", request: HttpRequestBuilder.() -> Unit = {}, block: suspend ClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.webSocketRawSession(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = 80, path: String = "/", block: HttpRequestBuilder.() -> Unit = {}): ClientWebSocketSession
suspend fun HttpClient.webSocketSession(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = 80, path: String = "/", block: HttpRequestBuilder.() -> Unit = {}): DefaultClientWebSocketSession
suspend fun HttpClient.ws(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = 80, path: String = "/", request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.wsRaw(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = 80, path: String = "/", request: HttpRequestBuilder.() -> Unit = {}, block: suspend ClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.wss(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = 443, path: String = "/", request: HttpRequestBuilder.() -> Unit = {}, block: suspend DefaultClientWebSocketSession.() -> Unit): Unit
suspend fun HttpClient.wssRaw(method: HttpMethod = HttpMethod.Get, host: String = "localhost", port: Int = 443, path: String = "/", request: HttpRequestBuilder.() -> Unit = {}, block: suspend ClientWebSocketSession.() -> Unit): Unit
package io.ktor.client.request
Module Contents
abstract class ClientUpgradeContent : NoContent
interface HttpRequest : HttpMessage
class HttpRequestBuilder : HttpMessageBuilder
class HttpRequestData
class HttpRequestPipeline : Pipeline<Any, HttpRequestBuilder>
class HttpSendPipeline : Pipeline<Any, HttpRequestBuilder>
fun HttpRequestBuilder.accept(contentType: ContentType): Unit
inline suspend fun <reified T> HttpClient.get(builder: HttpRequestBuilder): T
inline suspend fun <reified T> HttpClient.get(scheme: String = "http", host: String = "localhost", port: Int = 80, path: String = "/", body: Any = EmptyContent, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.get(url: URL, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.get(url: String, block: HttpRequestBuilder.() -> Unit = {}): T
fun HttpRequestBuilder.header(: String, : String): Unit
fun HttpRequestBuilder.headers(: HeadersBuilder.() -> Unit): HeadersBuilder
val HttpRequestBuilder.host: String
operator fun HttpRequestBuilder.Companion.invoke(block: URLBuilder.() -> Unit): HttpRequestBuilder
operator fun HttpRequestBuilder.Companion.invoke(scheme: String = "http", host: String = "localhost", port: Int = 80, path: String = "/", block: URLBuilder.() -> Unit = {}): HttpRequestBuilder
operator fun HttpRequestBuilder.Companion.invoke(url: URL): HttpRequestBuilder
val HttpRequestBuilder.port: Int
inline suspend fun <reified T> HttpClient.post(builder: HttpRequestBuilder): T
inline suspend fun <reified T> HttpClient.post(scheme: String = "http", host: String = "localhost", port: Int = 80, path: String = "/", body: Any = EmptyContent, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.post(url: URL, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.post(url: String, block: HttpRequestBuilder.() -> Unit = {}): T
inline suspend fun <reified T> HttpClient.request(builder: HttpRequestBuilder = HttpRequestBuilder()): T
inline suspend fun <reified T> HttpClient.request(block: HttpRequestBuilder.() -> Unit): T
fun request(block: HttpRequestBuilder.() -> Unit): HttpRequestBuilder
fun HttpRequestBuilder.takeFrom(builder: HttpRequestBuilder): HttpRequestBuilder
fun HttpRequestBuilder.takeFrom(request: HttpRequestData): HttpRequestBuilder
fun HttpRequestBuilder.url(block: URLBuilder.() -> Unit): Unit
fun HttpRequestBuilder.url(scheme: String = "http", host: String = "localhost", port: Int = 80, path: String = "/", block: URLBuilder.() -> Unit = {}): Unit
fun HttpRequestBuilder.url(url: URL): Unit
fun HttpRequestBuilder.url(url: String): Unit
package io.ktor.client.response
package io.ktor.client.tests
package io.ktor.client.tests.cio
package io.ktor.client.tests.utils
package io.ktor.client.utils
package io.ktor.config
package io.ktor.content
Module Contents
class ByteArrayContent : ByteArrayContent
data class CachingOptions
val CachingProperty: AttributeKey<CachingOptions>
data class EntityTagVersion : Version
class HttpStatusCodeContent : NoContent
interface IncomingContent : HttpMessage
class JarFileContent : ReadChannelContent
data class LastModifiedVersion : Version
class LocalFileContent : ReadChannelContent
fun LocalFileContent(baseDir: File, relativePath: String, contentType: ContentType = ContentType.defaultForFilePath(relativePath)): LocalFileContent
fun LocalFileContent(baseDir: Path, relativePath: Path, contentType: ContentType = ContentType.defaultForFile(relativePath)): LocalFileContent
interface MultiPartData
sealed class OutgoingContent
sealed class PartData
class TextContent : ByteArrayContent
class URIFileContent : ReadChannelContent
interface Version
enum class VersionCheckResult
val VersionListProperty: AttributeKey<List<Version>>
class WriterContent : WriteChannelContent
var OutgoingContent.caching: CachingOptions?
fun Route.default(localPath: String): Unit
fun Route.default(localPath: File): Unit
fun Route.defaultResource(resource: String, resourcePackage: String? = null): Unit
fun Route.file(remotePath: String, localPath: String = remotePath): Unit
fun Route.file(remotePath: String, localPath: File): Unit
fun Route.files(folder: String): Unit
fun Route.files(folder: File): Unit
suspend fun MultiPartData.forEachPart(partHandler: suspend (PartData) -> Unit): Unit
suspend fun MultiPartData.readAllParts(): List<PartData>
suspend fun IncomingContent.readText(pool: ObjectPool<ByteBuffer>, charset: Charset? = null): String
suspend fun IncomingContent.readText(): String
suspend fun IncomingContent.readText(charset: Charset): String
fun ApplicationCall.resolveResource(path: String, resourcePackage: String? = null, classLoader: ClassLoader = application.environment.classLoader, mimeResolve: (String) -> ContentType = { ContentType.defaultForFileExtension(it) }): OutgoingContent?
fun Route.resource(remotePath: String, resource: String = remotePath, resourcePackage: String? = null): Unit
fun Route.resources(resourcePackage: String? = null): Unit
fun Route.static(configure: Route.() -> Unit): Route
fun Route.static(remotePath: String, configure: Route.() -> Unit): Route
var Route.staticBasePackage: String?
var Route.staticRootFolder: File?
fun PipelineContext<Any, ApplicationCall>.transformDefaultContent(value: Any): OutgoingContent?
var OutgoingContent.versions: List<Version>
package io.ktor.features
Module Contents
object AutoHeadResponse : ApplicationFeature<ApplicationCallPipeline, Unit, Unit>
class CORS
class CachingHeaders
class CallLogging
class Compression
interface CompressionEncoder
class CompressionEncoderBuilder : ConditionsHolderBuilder
data class CompressionEncoderConfig
data class CompressionOptions
class ConditionalHeaders
interface ConditionsHolderBuilder
interface ContentConverter
class ContentNegotiation
class DataConversion : ConversionService
class DefaultHeaders
object DeflateEncoder : CompressionEncoder
class DelegatingConversionService : ConversionService
object ForwardedHeaderSupport : ApplicationFeature<ApplicationCallPipeline, Unit, Unit>
object GzipEncoder : CompressionEncoder
class HSTS
class HttpsRedirect
object IdentityEncoder : CompressionEncoder
class MutableOriginConnectionPoint : RequestConnectionPoint
val MutableOriginConnectionPointKey: AttributeKey<MutableOriginConnectionPoint>
class PartialContent
typealias PartialContentSupport = PartialContent
class StatusPages
class UnsupportedMediaTypeException : Exception
object XForwardedHeadersSupport : ApplicationFeature<ApplicationCallPipeline, Config, Config>
fun ConditionsHolderBuilder.condition(predicate: ApplicationCall.(OutgoingContent) -> Boolean): Unit
val ApplicationCallPipeline.conversionService: ConversionService
val OutgoingContent.defaultVersions: List<Version>
fun Configuration.deflate(block: CompressionEncoderBuilder.() -> Unit = {}): Unit
fun ConditionsHolderBuilder.excludeContentType(vararg mimeTypes: ContentType): Unit
fun Configuration.gzip(block: CompressionEncoderBuilder.() -> Unit = {}): Unit
fun Configuration.identity(block: CompressionEncoderBuilder.() -> Unit = {}): Unit
fun ConditionsHolderBuilder.matchContentType(vararg mimeTypes: ContentType): Unit
fun ConditionsHolderBuilder.minimumSize(minSize: Long): Unit
val ApplicationRequest.origin: RequestConnectionPoint
fun Configuration.statusFile(vararg code: HttpStatusCode, filePattern: String): Unit
fun ApplicationCall.suitableCharset(defaultCharset: Charset = Charsets.UTF_8): Charset
fun ApplicationRequest.toLogString(): String
suspend fun ApplicationCall.withETag(etag: String, : Boolean = true, block: suspend () -> Unit): Unit
suspend fun ApplicationCall.withLastModified(lastModified: ZonedDateTime, : Boolean = true, block: suspend () -> Unit): Unit
fun writeMultipleRanges(channelProducer: (LongRange) -> ByteReadChannel, ranges: List<LongRange>, fullLength: Long?, boundary: String, contentType: String): ByteReadChannel
package io.ktor.freemarker
package io.ktor.gson
package io.ktor.html
Module Contents
class HtmlContent : WriteChannelContent
open class Placeholder<TOuter>
class PlaceholderItem<TOuter> : Placeholder<TOuter>
open class PlaceholderList<TOuter, TInner>
interface Template<in TOuter>
open class TemplatePlaceholder<TTemplate>
fun <TOuter, TInner> TOuter.each(items: PlaceholderList<TOuter, TInner>, itemTemplate: TOuter.(PlaceholderItem<TInner>) -> Unit): Unit
fun <TOuter> TOuter.insert(placeholder: Placeholder<TOuter>): Unit
fun <TTemplate : Template<TOuter>, TOuter> TOuter.insert(template: TTemplate, placeholder: TemplatePlaceholder<TTemplate>): Unit
fun <TOuter, TTemplate : Template<TOuter>> TOuter.insert(template: TTemplate, build: TTemplate.() -> Unit): Unit
suspend fun ApplicationCall.respondHtml(status: HttpStatusCode = HttpStatusCode.OK, block: HTML.() -> Unit): Unit
suspend fun <TTemplate : Template<HTML>> ApplicationCall.respondHtmlTemplate(template: TTemplate, status: HttpStatusCode = HttpStatusCode.OK, body: TTemplate.() -> Unit): Unit
package io.ktor.http
Module Contents
class BadContentTypeFormatException : Exception
sealed class CacheControl
class ContentDisposition : HeaderValueWithParameters
sealed class ContentRange
class ContentType : HeaderValueWithParameters
data class Cookie
Module Contents
Cookie(name: String, value: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING, maxAge: Int = 0, expires: Temporal? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap())
val domain: String?
val encoding: CookieEncoding
val expires: Temporal?
val extensions: Map<String, String?>
val httpOnly: Boolean
val maxAge: Int
val name: String
val path: String?
val secure: Boolean
val value: String
enum class CookieEncoding
object EmptyHeaders : Headers
object EmptyParameters : Parameters
data class HeaderValue
data class HeaderValueParam
abstract class HeaderValueWithParameters
interface Headers : StringValues
class HeadersBuilder : StringValuesBuilder
class HeadersImpl : Headers, StringValuesImpl
class HeadersSingleImpl : Headers, StringValuesSingleImpl
object HttpHeaders
interface HttpMessage
interface HttpMessageBuilder
data class HttpMethod
data class HttpProtocolVersion
data class HttpStatusCode
class LinkHeader : HeaderValueWithParameters
interface Parameters : StringValues
class ParametersBuilder : StringValuesBuilder
class ParametersImpl : Parameters, StringValuesImpl
class ParametersSingleImpl : Parameters, StringValuesSingleImpl
enum class RangeUnits
data class RangesSpecifier
interface RequestConnectionPoint
class URLBuilder
data class URLProtocol
data class Url
fun HeaderValueWithParameters.charset(): Charset?
fun HttpMessageBuilder.charset(charset: Charset): Unit?
fun HttpMessageBuilder.charset(): Charset?
fun HttpMessage.charset(): Charset?
fun HeadersBuilder.contentLength(: Long): Unit
fun HttpMessageBuilder.contentLength(length: Int): Unit
fun HttpMessageBuilder.contentLength(): Int?
fun HttpMessage.contentLength(): Int?
fun contentRangeHeaderValue(: LongRange?, : Long? = null, : RangeUnits = RangeUnits.Bytes): String
fun contentRangeHeaderValue(: LongRange?, : Long? = null, : String = RangeUnits.Bytes.unitToken): String
fun HeadersBuilder.contentType(: ContentType): Unit
fun HttpMessageBuilder.contentType(type: ContentType): Unit
fun HttpMessageBuilder.contentType(): ContentType?
fun HttpMessage.contentType(): ContentType?
fun HttpMessageBuilder.cookies(): List<Cookie>
fun decodeCookieValue(encodedValue: String, encoding: CookieEncoding): String
fun decodeURLPart(text: String, start: Int = 0, end: Int = text.length): String
fun decodeURLQueryComponent(text: CharSequence, start: Int = 0, end: Int = text.length): String
fun ContentType.Companion.defaultForFile(file: File): ContentType
fun ContentType.Companion.defaultForFile(file: Path): ContentType
fun ContentType.Companion.defaultForFileExtension(extension: String): ContentType
fun ContentType.Companion.defaultForFilePath(path: String): ContentType
fun encodeCookieValue(value: String, encoding: CookieEncoding): String
fun encodeURLPart(s: String): String
fun encodeURLQueryComponent(s: String): String
fun HeadersBuilder.etag(: String): Unit
fun HttpMessageBuilder.etag(): String?
fun HttpMessage.etag(): String?
fun HeadersBuilder.expires(: LocalDateTime): Unit
fun HttpMessageBuilder.expires(): Date?
fun HttpMessage.expires(): Date?
fun ContentType.fileExtensions(): List<String>
fun Parameters.formUrlEncode(): String
fun Parameters.formUrlEncodeTo(out: Appendable): Unit
fun ContentType.Companion.fromFileExtension(ext: String): List<ContentType>
fun ContentType.Companion.fromFilePath(path: String): List<ContentType>
val Url.fullPath: String
fun headersOf(): Headers
fun headersOf(: String, : String): Headers
fun headersOf(: String, : List<String>): Headers
fun headersOf(vararg : Pair<String, List<String>>): Headers
val Url.hostWithPort: String
val httpDateFormat: DateTimeFormatter
fun HttpMessageBuilder.ifModifiedSince(date: Date): Unit
fun HttpMessageBuilder.ifNoneMatch(value: String): Unit
fun URLProtocol.isSecure(): Boolean
fun HttpStatusCode.isSuccess(): Boolean
fun URLProtocol.isWebsocket(): Boolean
java.time.temporal.Temporal
kotlin.Long
kotlin.String
kotlin.collections.Iterable
kotlin.collections.List
fun HeadersBuilder.lastModified(: ZonedDateTime): Unit
fun HttpMessageBuilder.lastModified(): Date?
fun HttpMessage.lastModified(): Date?
fun ApplicationResponse.link(: LinkHeader): Unit
fun ApplicationResponse.link(uri: String, vararg rel: String): Unit
fun HttpMessageBuilder.maxAge(seconds: Int): Unit
fun parametersOf(): Parameters
fun parametersOf(name: String, value: String): Parameters
fun parametersOf(name: String, values: List<String>): Parameters
fun parametersOf(vararg pairs: Pair<String, List<String>>): Parameters
fun parseAndSortContentTypeHeader(header: String?): List<HeaderValue>
fun parseAndSortHeader(header: String?): List<HeaderValue>
fun parseClientCookiesHeader(: String, : Boolean = true): Map<String, String>
fun parseHeaderValue(: String?, : Boolean = false): List<HeaderValue>
fun parseQueryString(query: CharSequence, startIndex: Int = 0, limit: Int = 1000): Parameters
fun parseRangesSpecifier(rangeSpec: String): RangesSpecifier?
fun parseServerSetCookieHeader(: String): Cookie
operator fun Parameters.plus(other: Parameters): Parameters
fun ApplicationCall.push(pathAndQuery: String): Unit
fun ApplicationCall.push(encodedPath: String, parameters: Parameters): Unit
fun ApplicationCall.push(block: ResponsePushBuilder.() -> Unit): Unit
fun renderSetCookieHeader(: Cookie): String
fun renderSetCookieHeader(: String, : String, : CookieEncoding = CookieEncoding.URI_ENCODING, : Int = 0, : Temporal? = null, domain: String? = null, : String? = null, : Boolean = false, : Boolean = false, : Map<String, String?> = emptyMap()): String
fun HttpMessage.setCookie(): List<Cookie>
fun URLBuilder.takeFrom(url: String): Unit
fun URLBuilder.takeFrom(uri: URI): Unit
fun URLBuilder.takeFrom(url: URL): Unit
fun URLBuilder.takeFrom(url: URLBuilder): URLBuilder
fun URLBuilder.takeFrom(url: Url): URLBuilder
fun HttpMessageBuilder.userAgent(content: String): Unit
fun HttpMessageBuilder.vary(): List<String>?
fun HttpMessage.vary(): List<String>?
fun ContentType.withCharset(charset: Charset): ContentType
package io.ktor.http.cio
Module Contents
class CIOHeaders : Headers
class CIOMultipartData : CIOMultipartDataBase
open class CIOMultipartDataBase : MultiPartData
class ConnectionOptions
typealias DecoderJob = WriterJob
typealias EncoderJob = ReaderJob
class HttpHeadersMap
abstract class HttpMessage
val HttpPipelineCoroutine: CoroutineName
val HttpPipelineWriterCoroutine: CoroutineName
typealias HttpRequestHandler = suspend (request: Request, input: ByteReadChannel, output: ByteWriteChannel, upgraded: CompletableDeferred<Boolean>?) -> Unit
sealed class MultipartEvent
class ParserException : Exception
class Request : HttpMessage
class RequestResponseBuilder
class Response : HttpMessage
suspend fun boundary(boundaryPrefixed: ByteBuffer, input: ByteReadChannel): Boolean
suspend fun copyMultipart(: HttpHeadersMap, : ByteReadChannel, : ByteWriteChannel): Unit
suspend fun decodeChunked(input: ByteReadChannel, coroutineContext: CoroutineContext): DecoderJob
suspend fun decodeChunked(input: ByteReadChannel, out: ByteWriteChannel): Unit
fun HttpHeadersMap.dumpTo(: String, : Appendable): Unit
suspend fun encodeChunked(output: ByteWriteChannel, coroutineContext: CoroutineContext): EncoderJob
suspend fun encodeChunked(output: ByteWriteChannel, input: ByteReadChannel): Unit
fun expectHttpBody(method: HttpMethod, contentLength: Long, transferEncoding: CharSequence?, connectionOptions: ConnectionOptions?, contentType: CharSequence?): Boolean
fun expectHttpBody(request: Request): Boolean
fun expectHttpUpgrade(method: HttpMethod, upgrade: CharSequence?, connectionOptions: ConnectionOptions?): Boolean
fun expectHttpUpgrade(request: Request): Boolean
fun expectMultipart(: HttpHeadersMap): Boolean
suspend fun handleConnectionPipeline(input: ByteReadChannel, output: ByteWriteChannel, ioCoroutineContext: CoroutineContext, callContext: CoroutineContext, timeouts: WeakTimeoutQueue, handler: HttpRequestHandler): Unit
fun lastHttpRequest(http11: Boolean, connectionOptions: ConnectionOptions?): Boolean
suspend fun parseHttpBody(contentLength: Long, transferEncoding: CharSequence?, connectionOptions: ConnectionOptions?, input: ByteReadChannel, out: ByteWriteChannel): Unit
suspend fun parseHttpBody(headers: HttpHeadersMap, input: ByteReadChannel, out: ByteWriteChannel): Unit
fun parseMultipart(: CoroutineContext, : ByteReadChannel, : HttpHeadersMap): ReceiveChannel<MultipartEvent>
fun parseMultipart(coroutineContext: CoroutineContext, input: ByteReadChannel, contentType: CharSequence, contentLength: Long?): ReceiveChannel<MultipartEvent>
fun parseMultipart(coroutineContext: CoroutineContext, boundaryPrefixed: ByteBuffer, input: ByteReadChannel, totalLength: Long?): ReceiveChannel<MultipartEvent>
suspend fun parsePart(boundaryPrefixed: ByteBuffer, input: ByteReadChannel, output: ByteWriteChannel, limit: Long = Long.MAX_VALUE): Pair<HttpHeadersMap, Long>
suspend fun parsePartBody(boundaryPrefixed: ByteBuffer, input: ByteReadChannel, output: ByteWriteChannel, headers: HttpHeadersMap, limit: Long = Long.MAX_VALUE): Long
suspend fun parsePartHeaders(: ByteReadChannel): HttpHeadersMap
suspend fun parsePreamble(boundaryPrefixed: ByteBuffer, input: ByteReadChannel, output: BytePacketBuilder, limit: Long = Long.MAX_VALUE): Long
suspend fun parseRequest(input: ByteReadChannel): Request?
suspend fun parseResponse(input: ByteReadChannel): Response?
fun startConnectionPipeline(input: ByteReadChannel, output: ByteWriteChannel, parentJob: CoroutineContext?, ioContext: CoroutineContext, callContext: CoroutineContext, timeout: WeakTimeoutQueue, handler: HttpRequestHandler): Job
package io.ktor.http.cio.internals
package io.ktor.http.cio.websocket
package io.ktor.http.websocket
package io.ktor.jackson
package io.ktor.locations
Module Contents
annotation class Location
class LocationAttributeRouteService : LocationRouteService
interface LocationRouteService
open class Locations
class RoutingException : Exception
inline fun <reified T : Any> Route.delete(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.get(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.handle(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Unit
fun <T : Any> Route.handle(dataClass: KClass<T>, body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Unit
inline fun <reified T : Any> Route.head(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
typealias location = Location
inline fun <reified T : Any> Route.location(noinline body: Route.() -> Unit): Route
fun <T : Any> Route.location(data: KClass<T>, body: Route.() -> Unit): Route
val PipelineContext<Unit, ApplicationCall>.locations: Locations
val ApplicationCall.locations: Locations
val Application.locations: Locations
inline fun <reified T : Any> Route.options(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.patch(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.post(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
inline fun <reified T : Any> Route.put(noinline body: suspend PipelineContext<Unit, ApplicationCall>.(T) -> Unit): Route
fun ApplicationCall.url(location: Any, block: URLBuilder.() -> Unit = {}): String
package io.ktor.metrics
package io.ktor.network.selector
package io.ktor.network.sockets
Module Contents
interface ABoundSocket
interface AConnectedSocket : AWritable
interface AReadable
interface ASocket : Closeable, DisposableHandle
interface AWritable
interface Acceptable<out S : ASocket> : ASocket
interface BoundDatagramSocket : ASocket, ABoundSocket, AReadable, DatagramReadWriteChannel
interface Configurable<out T : Configurable<T>>
interface ConnectedDatagramSocket : ASocket, ABoundSocket, AConnectedSocket, ReadWriteSocket, DatagramReadWriteChannel
class Datagram
interface DatagramReadChannel
interface DatagramReadWriteChannel : DatagramReadChannel, DatagramWriteChannel
interface DatagramWriteChannel
interface ReadWriteSocket : ASocket, AReadable, AWritable
interface ServerSocket : ASocket, ABoundSocket, Acceptable<Socket>
interface Socket : ReadWriteSocket, ABoundSocket, AConnectedSocket
class SocketBuilder : Configurable<SocketBuilder>
class SocketOptions
class TcpSocketBuilder : Configurable<TcpSocketBuilder>
class UDPSocketBuilder : Configurable<UDPSocketBuilder>
fun aSocket(selector: SelectorManager = SelectorManager.DefaultSelectorManager): SocketBuilder
suspend fun ASocket.awaitClosed(): Unit
val ASocket.isClosed: Boolean
fun AReadable.openReadChannel(): ByteReadChannel
fun AWritable.openWriteChannel(autoFlush: Boolean = false): ByteWriteChannel
fun <T : Configurable<T>> T.tcpNoDelay(): T
package io.ktor.network.tls
Module Contents
class CipherSuite
Module Contents
CipherSuite(code: Short, name: String, openSSLName: String, exchangeType: SecretExchangeType, jdkCipherName: String, keyStrength: Int, fixedIvLength: Int, ivLength: Int, cipherTagSizeInBytes: Int, macName: String, macStrength: Int, hashName: String)
val cipherTagSizeInBytes: Int
val code: Short
val exchangeType: SecretExchangeType
val fixedIvLength: Int
val hashName: String
val ivLength: Int
val jdkCipherName: String
val keyStrength: Int
val keyStrengthInBytes: Int
val macName: String
val macStrength: Int
val macStrengthInBytes: Int
val name: String
val openSSLName: String
enum class SecretExchangeType
enum class TLSAlertLevel
enum class TLSAlertType
class TLSException : IOException
class TLSHandshakeHeader
enum class TLSHandshakeType
class TLSRecordHeader
enum class TLSRecordType
enum class TLSVersion
kotlinx.coroutines.experimental.io.ByteReadChannel
kotlinx.io.core.BytePacketBuilder
kotlinx.io.core.ByteReadPacket
suspend fun ReadWriteSocket.tls(trustManager: X509TrustManager? = null, serverName: String? = null, coroutineContext: CoroutineContext = ioCoroutineDispatcher): ReadWriteSocket
suspend fun Socket.tls(trustManager: X509TrustManager? = null, randomAlgorithm: String = "NativePRNGNonBlocking", serverName: String? = null, coroutineContext: CoroutineContext = ioCoroutineDispatcher): Socket
package io.ktor.network.util
package io.ktor.org.apache.commons.collections4.map
package io.ktor.pipeline
Module Contents
@DslMarker @Target([AnnotationTarget.CLASS, AnnotationTarget.TYPEALIAS, AnnotationTarget.TYPE, AnnotationTarget.FUNCTION]) annotation class ContextDsl
class InvalidPhaseException : Throwable
open class Pipeline<TSubject : Any, TContext : Any>
class PipelineContext<TSubject : Any, out TContext : Any>
typealias PipelineInterceptor<TSubject, TContext> = suspend PipelineContext<TSubject, TContext>.(TSubject) -> Unit
class PipelinePhase
inline suspend fun <TContext : Any> Pipeline<Unit, TContext>.execute(context: TContext): Unit
inline fun <reified TSubject : Any, TContext : Any> Pipeline<*, TContext>.intercept(phase: PipelinePhase, noinline block: suspend PipelineContext<TSubject, TContext>.(TSubject) -> Unit): Unit
package io.ktor.request
package io.ktor.response
Module Contents
interface ApplicationResponse
open class ApplicationSendPipeline : Pipeline<Any, ApplicationCall>
class DefaultResponsePushBuilder : ResponsePushBuilder
class ResponseCookies
Module Contents
ResponseCookies(response: ApplicationResponse, secureTransport: Boolean)
fun append(item: Cookie): Unit
fun append(name: String, value: String, encoding: CookieEncoding = CookieEncoding.URI_ENCODING, maxAge: Int = 0, expires: Temporal? = null, domain: String? = null, path: String? = null, secure: Boolean = false, httpOnly: Boolean = false, extensions: Map<String, String?> = emptyMap()): Unit
fun appendExpired(name: String, domain: String? = null, path: String? = null): Unit
operator fun get(name: String): Cookie?
abstract class ResponseHeaders
interface ResponsePushBuilder
class UnsafeHeaderException : IllegalArgumentException
fun ApplicationResponse.cacheControl(value: CacheControl): Unit
fun HeadersBuilder.cacheControl(: CacheControl): Unit
fun ApplicationResponse.contentLength(length: Long): Unit
fun HeadersBuilder.contentRange(: LongRange?, : Long? = null, : String = RangeUnits.Bytes.unitToken): Unit
fun ApplicationResponse.contentRange(range: LongRange?, fullLength: Long? = null, unit: RangeUnits): Unit
fun ApplicationResponse.contentRange(range: LongRange?, fullLength: Long? = null, unit: String = RangeUnits.Bytes.unitToken): Unit
fun ApplicationResponse.contentType(value: ContentType): Unit
fun ApplicationResponse.contentType(value: String): Unit
fun ApplicationCall.defaultTextContentType(contentType: ContentType?): ContentType
fun ApplicationResponse.etag(value: String): Unit
fun ApplicationResponse.expires(value: LocalDateTime): Unit
fun ApplicationResponse.header(: String, : String): Unit
fun ApplicationResponse.header(: String, : Int): Unit
fun ApplicationResponse.header(: String, : Long): Unit
fun ApplicationResponse.header(: String, : Temporal): Unit
fun ApplicationResponse.lastModified(dateTime: ZonedDateTime): Unit
inline suspend fun ApplicationCall.respond(message: Any): Unit
inline suspend fun ApplicationCall.respond(status: HttpStatusCode, message: Any): Unit
suspend fun ApplicationCall.respondFile(baseDir: File, fileName: String, configure: OutgoingContent.() -> Unit = {}): Unit
suspend fun ApplicationCall.respondFile(file: File, configure: OutgoingContent.() -> Unit = {}): Unit
suspend fun ApplicationCall.respondRedirect(url: String, permanent: Boolean = false): Unit
inline suspend fun ApplicationCall.respondRedirect(permanent: Boolean = false, block: URLBuilder.() -> Unit): Unit
suspend fun ApplicationCall.respondText(text: String, contentType: ContentType? = null, status: HttpStatusCode? = null, configure: OutgoingContent.() -> Unit = {}): Unit
suspend fun ApplicationCall.respondText(contentType: ContentType? = null, status: HttpStatusCode? = null, provider: suspend () -> String): Unit
suspend fun ApplicationCall.respondWrite(contentType: ContentType? = null, status: HttpStatusCode? = null, writer: suspend Writer.() -> Unit): Unit
package io.ktor.routing
Module Contents
data class AndRouteSelector : RouteSelector
data class ConstantParameterRouteSelector : RouteSelector
data class HttpAcceptRouteSelector : RouteSelector
data class HttpHeaderRouteSelector : RouteSelector
data class HttpMethodRouteSelector : RouteSelector
data class OptionalParameterRouteSelector : RouteSelector
data class OrRouteSelector : RouteSelector
data class ParameterRouteSelector : RouteSelector
data class PathSegmentConstantRouteSelector : RouteSelector
data class PathSegmentOptionalParameterRouteSelector : RouteSelector
data class PathSegmentParameterRouteSelector : RouteSelector
object PathSegmentSelectorBuilder
data class PathSegmentTailcardRouteSelector : RouteSelector
object PathSegmentWildcardRouteSelector : RouteSelector
open class Route : ApplicationCallPipeline
abstract class RouteSelector
data class RouteSelectorEvaluation
class Routing : Route
class RoutingApplicationCall : ApplicationCall
class RoutingApplicationRequest : ApplicationRequest
class RoutingApplicationResponse : ApplicationResponse
class RoutingPath
data class RoutingPathSegment
enum class RoutingPathSegmentKind
class RoutingResolveContext
sealed class RoutingResolveResult
class RoutingResolveTrace
open class RoutingResolveTraceEntry
fun Route.accept(contentType: ContentType, build: Route.() -> Unit): Route
val Route.application: Application
fun Route.contentType(contentType: ContentType, build: Route.() -> Unit): Route
fun Route.createRouteFromPath(path: String): Route
fun Route.delete(path: String, body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.delete(body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.get(path: String, body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.get(body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.head(path: String, body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.head(body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.header(: String, : String, : Route.() -> Unit): Route
fun Route.method(method: HttpMethod, body: Route.() -> Unit): Route
fun Route.optionalParam(name: String, build: Route.() -> Unit): Route
fun Route.options(path: String, body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.options(body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.param(name: String, value: String, build: Route.() -> Unit): Route
fun Route.param(name: String, build: Route.() -> Unit): Route
fun Route.patch(path: String, body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.patch(body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.post(path: String, body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.post(body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.put(path: String, body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.put(body: PipelineInterceptor<Unit, ApplicationCall>): Route
fun Route.route(path: String, build: Route.() -> Unit): Route
fun Route.route(path: String, method: HttpMethod, build: Route.() -> Unit): Route
fun Application.routing(configuration: Routing.() -> Unit): Routing
package io.ktor.server.cio
package io.ktor.server.engine
Module Contents
interface ApplicationEngine
interface ApplicationEngineEnvironment : ApplicationEnvironment
class ApplicationEngineEnvironmentBuilder
class ApplicationEngineEnvironmentReloading : ApplicationEngineEnvironment
interface ApplicationEngineFactory<out TEngine : ApplicationEngine, TConfiguration : Configuration>
abstract class BaseApplicationCall : ApplicationCall
abstract class BaseApplicationEngine : ApplicationEngine
abstract class BaseApplicationRequest : ApplicationRequest
abstract class BaseApplicationResponse : ApplicationResponse
data class ConnectorType
open class EngineConnectorBuilder : EngineConnectorConfig
interface EngineConnectorConfig
class EnginePipeline : Pipeline<Unit, ApplicationCall>
class EngineSSLConnectorBuilder : EngineConnectorBuilder, EngineSSLConnectorConfig
interface EngineSSLConnectorConfig : EngineConnectorConfig
class ShutDownUrl
fun applicationEngineEnvironment(builder: ApplicationEngineEnvironmentBuilder.() -> Unit): ApplicationEngineEnvironment
fun commandLineEnvironment(args: Array<String>): ApplicationEngineEnvironment
inline fun ApplicationEngineEnvironmentBuilder.connector(builder: EngineConnectorBuilder.() -> Unit): Unit
fun defaultEnginePipeline(environment: ApplicationEnvironment): EnginePipeline
fun <TEngine : ApplicationEngine, TConfiguration : Configuration> embeddedServer(factory: ApplicationEngineFactory<TEngine, TConfiguration>, port: Int = 80, host: String = "0.0.0.0", watchPaths: List<String> = emptyList(), configure: TConfiguration.() -> Unit = {}, module: Application.() -> Unit): TEngine
fun <TEngine : ApplicationEngine, TConfiguration : Configuration> embeddedServer(factory: ApplicationEngineFactory<TEngine, TConfiguration>, environment: ApplicationEngineEnvironment, configure: TConfiguration.() -> Unit = {}): TEngine
fun ApplicationSendPipeline.installDefaultTransformations(): Unit
fun ApplicationReceivePipeline.installDefaultTransformations(): Unit
fun Configuration.loadCommonConfiguration(deploymentConfig: ApplicationConfig): Unit
inline fun ApplicationEngineEnvironmentBuilder.sslConnector(keyStore: KeyStore, keyAlias: String, noinline keyStorePassword: () -> CharArray, noinline privateKeyPassword: () -> CharArray, builder: EngineSSLConnectorBuilder.() -> Unit): Unit
package io.ktor.server.jetty
package io.ktor.server.jetty.internal
package io.ktor.server.netty
package io.ktor.server.netty.cio
package io.ktor.server.servlet
package io.ktor.server.servlet.v4
package io.ktor.server.testing
Module Contents
abstract class EngineStressSuite<TEngine : ApplicationEngine, TConfiguration : Configuration> : EngineTestBase<TEngine, TConfiguration>
abstract class EngineTestBase<TEngine : ApplicationEngine, TConfiguration : Configuration>
abstract class EngineTestSuite<TEngine : ApplicationEngine, TConfiguration : Configuration> : EngineTestBase<TEngine, TConfiguration>
object It
object On
class StressSuiteRunner : Runner
class TestApplicationCall : BaseApplicationCall
class TestApplicationEngine : BaseApplicationEngine
class TestApplicationRequest : BaseApplicationRequest
class TestApplicationResponse : BaseApplicationResponse
object TestEngine : ApplicationEngineFactory<TestApplicationEngine, Configuration>
fun TestApplicationResponse.contentType(): ContentType
fun createTestEnvironment(configure: ApplicationEngineEnvironmentBuilder.() -> Unit = {}): ApplicationEngineEnvironment
fun TestApplicationEngine.handleRequest(method: HttpMethod, uri: String, setup: TestApplicationRequest.() -> Unit = {}): TestApplicationCall
inline fun On.it(description: String, body: It.() -> Unit): Unit
fun on(: String, body: On.() -> Unit): Unit
fun TestApplicationRequest.setBody(value: String): Unit
fun TestApplicationRequest.setBody(value: ByteArray): Unit
fun TestApplicationRequest.setBody(boundary: String, values: List<PartData>): Unit
fun <R> withApplication(environment: ApplicationEngineEnvironment = createTestEnvironment(), configure: Configuration.() -> Unit = {}, test: TestApplicationEngine.() -> R): R
fun <R> withTestApplication(test: TestApplicationEngine.() -> R): R
fun <R> withTestApplication(moduleFunction: Application.() -> Unit, test: TestApplicationEngine.() -> R): R
fun <R> withTestApplication(moduleFunction: Application.() -> Unit, configure: Configuration.() -> Unit = {}, test: TestApplicationEngine.() -> R): R
package io.ktor.server.testing.client
package io.ktor.server.tomcat
package io.ktor.sessions
Module Contents
interface Cache<in K : Any, V : Any>
class CacheStorage : SessionStorage
class CookieConfiguration
class CookieIdSessionBuilder<S : Any> : CookieSessionBuilder<S>
open class CookieSessionBuilder<S : Any>
interface CurrentSession
class HeaderIdSessionBuilder<S : Any> : HeaderSessionBuilder<S>
open class HeaderSessionBuilder<S : Any>
class SessionProvider
interface SessionSerializer
class SessionSerializerReflection<T : Any> : SessionSerializer
interface SessionStorage
class SessionStorageMemory : SessionStorage
interface SessionTracker
class SessionTrackerById : SessionTracker
class SessionTrackerByValue : SessionTracker
interface SessionTransport
class SessionTransportCookie : SessionTransport
class SessionTransportHeader : SessionTransport
interface SessionTransportTransformer
class SessionTransportTransformerDigest : SessionTransportTransformer
class SessionTransportTransformerEncrypt : SessionTransportTransformer
class SessionTransportTransformerMessageAuthentication : SessionTransportTransformer
class Sessions
inline fun <reified T : Any> autoSerializerOf(): SessionSerializerReflection<T>
fun <T : Any> autoSerializerOf(type: KClass<T>): SessionSerializerReflection<T>
inline fun <reified T> CurrentSession.clear(): Unit
fun <S : Any> Configuration.cookie(name: String, sessionType: KClass<S>, storage: SessionStorage): Unit
inline fun <reified S : Any> Configuration.cookie(name: String, storage: SessionStorage): Unit
inline fun <reified S : Any> Configuration.cookie(name: String, storage: SessionStorage, block: CookieIdSessionBuilder<S>.() -> Unit): Unit
inline fun <S : Any> Configuration.cookie(name: String, sessionType: KClass<S>, storage: SessionStorage, block: CookieIdSessionBuilder<S>.() -> Unit): Unit
fun <S : Any> Configuration.cookie(name: String, sessionType: KClass<S>): Unit
inline fun <reified S : Any> Configuration.cookie(name: String): Unit
inline fun <reified S : Any> Configuration.cookie(name: String, block: CookieSessionBuilder<S>.() -> Unit): Unit
inline fun <S : Any> Configuration.cookie(name: String, sessionType: KClass<S>, block: CookieSessionBuilder<S>.() -> Unit): Unit
fun directorySessionStorage(rootDir: File, cached: Boolean = true): SessionStorage
inline fun <reified T> CurrentSession.get(): T?
fun <S : Any> Configuration.header(: String, : KClass<S>, : SessionStorage): Unit
inline fun <reified S : Any> Configuration.header(: String, : SessionStorage): Unit
inline fun <reified S : Any> Configuration.header(: String, : SessionStorage, : HeaderIdSessionBuilder<S>.() -> Unit): Unit
inline fun <S : Any> Configuration.header(: String, : KClass<S>, : SessionStorage, : HeaderIdSessionBuilder<S>.() -> Unit): Unit
fun <S : Any> Configuration.header(: String, : KClass<S>): Unit
inline fun <reified S : Any> Configuration.header(: String): Unit
inline fun <reified S : Any> Configuration.header(: String, : HeaderSessionBuilder<S>.() -> Unit): Unit
inline fun <S : Any> Configuration.header(: String, : KClass<S>, : HeaderSessionBuilder<S>.() -> Unit): Unit
kotlin.collections.List
val ApplicationCall.sessions: CurrentSession
inline fun <reified T> CurrentSession.set(value: T?): Unit
package io.ktor.util
Module Contents
class AttributeKey<T>
class Attributes
class ByteBufferBuilder
class CaseInsensitiveMap<V> : AbstractLinkedMap<String, V>, MutableMap<String, V>
interface ConversionService
class DataConversionException : Exception
object DefaultConversionService : ConversionService
class DispatcherWithShutdown : CoroutineDispatcher
val GreenwichMeanTime: ZoneId
interface StringValues
open class StringValuesBuilder
open class StringValuesImpl : StringValues
open class StringValuesSingleImpl : StringValues
interface ValuesMap
fun StringValuesBuilder.appendAll(builder: StringValuesBuilder): StringValuesBuilder
fun StringValuesBuilder.appendFiltered(source: StringValues, keepEmpty: Boolean = false, predicate: (String, String) -> Boolean): Unit
fun URLBuilder.Companion.createFromCall(call: ApplicationCall): URLBuilder
fun decodeBase64(s: String): ByteArray
fun encodeBase64(bytes: ByteArray): String
fun StringValues.filter(keepEmpty: Boolean = false, predicate: (String, String) -> Boolean): StringValues
fun StringValues.flattenEntries(): List<Pair<String, String>>
fun StringValues.flattenForEach(block: (String, String) -> Unit): Unit
fun generateCertificate(file: File, algorithm: String = "SHA1withRSA", keyAlias: String = "mykey", keyPassword: String = "changeit", jksPassword: String = keyPassword): KeyStore
fun getDigestFunction(algorithm: String, salt: String): (String) -> ByteArray
fun hex(s: String): ByteArray
fun hex(bytes: ByteArray): String
java.io.File
java.lang.Class
java.nio.ByteBuffer
java.nio.file.Path
java.util.Date
Module Contents
fun Date.toLocalDateTime(): LocalDateTime
fun Date.toZonedDateTime(): ZonedDateTime
kotlin.String
kotlin.ranges.LongRange
kotlinx.coroutines.experimental.io.ByteReadChannel
kotlinx.coroutines.experimental.io.ByteWriteChannel
fun nextNonce(): String
val nonceRandom: Random
org.slf4j.Logger
fun raw(s: String): ByteArray
fun sha1(bytes: ByteArray): ByteArray
fun StringValues.toMap(): Map<String, List<String>>
fun url(block: URLBuilder.() -> Unit): String
inline fun ApplicationCall.url(block: URLBuilder.() -> Unit = {}): String
fun valuesOf(vararg pairs: Pair<String, List<String>>, caseInsensitiveKey: Boolean = false): StringValues
fun valuesOf(name: String, value: String, caseInsensitiveKey: Boolean = false): StringValues
fun valuesOf(name: String, values: List<String>, caseInsensitiveKey: Boolean = false): StringValues
fun valuesOf(): StringValues
fun valuesOf(map: Map<String, Iterable<String>>, caseInsensitiveKey: Boolean = false): StringValues
package io.ktor.velocity
package io.ktor.websocket